home *** CD-ROM | disk | FTP | other *** search
/ The X-Philes (2nd Revision) / The X-Philes Number 1 (1995).iso / xphiles / hp48_2 / machine_.tar / MAIL-SERVER < prev    next >
Text File  |  1991-05-17  |  9KB  |  271 lines
  1.  
  2.     How to use the Wayne's Mail Server
  3.     ====================================
  4.  
  5. The Wayne's Mail Server can be reached at e-mail address
  6. "hp-mail-server@seq.uncwil.edu".   
  7. If your mailer doesn't understand domain addresses, 
  8. try a nearby gateway like "uunet".
  9.  
  10. When the Mail Server receives a message, It reads the mail headers
  11. to determine the requester's address. If a "Reply-To:" header is
  12. found, the indicated address is used. If not, it uses the address as
  13. specified in the "From:" header.  You can overide this path with
  14. the path command below.
  15.  
  16. The message body is scanned for server commands. Every line in the
  17. message should contain a valid server command.
  18.  
  19. A report is sent to you by return mail. Any requests will be handled
  20. as soon as the load of the server system permits.
  21.  
  22.     NOTE: The mail server is still under development. Things
  23.     may -and will- change in the near future.
  24.  
  25. The Server's Archives
  26. =====================
  27. By default the server get files from the HP-48 archive.  If you want to
  28. use the HP-28 archive include the HP28 command below.
  29.  
  30. Files are stored in the archives in one of the following formats:
  31.  
  32. Plain: normal ASCII text.
  33.  
  34. Shell Archive: ASCII files which can be unloaded using the
  35.     Unix sh(1) program.
  36.     Shell Archives have names ending in ".shar".
  37.  
  38. Compressed: 16-bit compression using the compress(1) utility.
  39.     Compressed files have names ending in ".Z".
  40.  
  41. Tar: standard UNIX tar(1) format.
  42.     Tar archives have names ending in ".tar".
  43.  
  44. Compressed Tar: compressed tar archive.
  45.     Compressed tar archives have names ending in ".tar.Z".
  46.  
  47. When requesting a file you do not have to specify the format-specific
  48. extension. A request for a file "foo" will automatically be changed to
  49. "foo", "foo.tar", "foo.shar", "foo.Z", "foo.tar.Z" whichever is available.
  50.  
  51. The file "INDEX" contains a list of files in the archives.
  52.  
  53. Command Syntax
  54. ==============
  55. A command consists of a keyword (verb), followed by zero or more
  56. arguments, depending on the command. Command verbs may be specified in
  57. all uppercase letters, lowercase or whatever mixed case. In other
  58. words: case is not significant in command verbs. Case *IS* significant
  59. in command arguments.
  60. Empty lines are ignored.
  61.  
  62. The following commands are understood by the server:
  63.  
  64. PATH <address>
  65. --------------
  66.     The return address used by the server is set to the indicated
  67.     <address>. This must be a valid address by which you can be
  68.     reached. It may contain a domain-based address.
  69.     Use this command if you are not sure that the return addresses
  70.     generated by your mail system are reliable.
  71.  
  72. END or EXIT
  73. -----------
  74.     The remainder of the message is ignored. This can be useful if a
  75.     .signature is appended to the message.
  76.  
  77. LIMIT <number>
  78. --------------
  79.     Specify the maximum number of bytes which may be sent in a single
  80.     mail message. Transfers exceeding this amount will be split
  81.     before sending.
  82.     The amount may be specified in Kbytes, e.g. "30K".
  83.     The default value is 64K.
  84.     NOTE: setting the limit will only affect "send" and "resend"
  85.     commands following this command.
  86.     NOTE: due to mailer overhead, it is possible that the size of the
  87.     mail which reaches you will (slightly) exceed this limit.
  88.  
  89. HP28
  90. ----
  91.     Use the HP-28 archive for ALL commands.  Note: it is not possible at
  92.     this time to get files from both the HP-48 directory and the HP-28
  93.     directory in one message.
  94.  
  95. UUENCODE
  96. --------
  97.     The requested items will be uuencoded before sending. Because most
  98.     archives are binary files, they are always encoded before sending.
  99.     Uuencoding is default.
  100.     Use "send uudecode" to obtain the uudecode/uuencode programs.
  101.     NOTE: setting the encoding will only affect "send" and "resend"
  102.     commands following this command.
  103.  
  104. BTOA
  105. ----
  106.     The requested files will be encoded using "btoa". Btoa encoded
  107.     files are smaller than uuencoded files, but not everyone can
  108.     handle btoa encoded files yet.
  109.     Use "send btoa" to obtain the btoa/atob coding programs.
  110.     NOTE: setting the encoding will only affect "send" and "resend"
  111.     commands following this command.
  112.  
  113. SEND <item>
  114. -----------
  115.     The specified <item> is looked up in the server archives. If
  116.     found, it will be sent to you by e-mail. Multiple items may be
  117.     specified with one SEND command.
  118.     NOTE: the names of the <item>s are case sentive!
  119.  
  120. RESEND <item> <part> [<part>...]
  121. --------------------------------
  122.     Re-send the indicated <part>s of this item. This is useful if not
  123.     all parts of a multi-parts transmission did arrive correctly.
  124.     When re-transmitting, the encoding and limit used must be
  125.     identical to those of the original transmission.
  126.  
  127. LATEST <days>
  128. -------------
  129.     Prints a list of all of the files that have been added to
  130.     the current archive in the last <days> days.
  131.  
  132. HELP
  133. ----
  134.     This command gives a list of server commands.
  135.  
  136. TEST
  137. ----
  138.     This command is for testing. No files will be sent if you use
  139.     this, but a confirmation message will be sent to the return path as
  140.     determined from the mail headers or the "path" command.  You may
  141.     use this to find out if your address is valid, and to check the
  142.     status of your request.
  143.    
  144. Sample Mail Server Report
  145. =========================
  146.  
  147. Sending:
  148.  
  149.     path jv@mh.nl
  150.     btoa
  151.     send INDEX bio
  152.     resend zoo 2 3 4
  153.     send foo
  154.     end
  155.  
  156. will generate the following report:
  157.  
  158.     From: Wayne's Mail Server <wscott@ecn.purdue.edu>
  159. [1]    To: jv@mh.nl
  160.     Subject: Your request
  161.     Date: Sun, 1 Oct 89 18:25:39 MET (+0100)
  162.  
  163.     Wayne's Mail Server 1.0
  164.  
  165.     Processing mail headers ...
  166. [2]    Return address: "Johan Vromans <jv@mhres.mh.nl>"
  167.  
  168.     Processing message contents...
  169.  
  170.     Command: path jv@mh.nl
  171. [3]    => Return address: "jv@mh.nl"
  172.  
  173.     Command: btoa
  174.     => Encoding = btoa
  175.  
  176.     Command: send INDEX bio
  177.     => Send: INDEX
  178.     => Send: bio
  179.  
  180.     Command: resend zoo 2 3 4
  181.     => Resend: zoo, parts 2,3,4
  182.  
  183.     Command: send foo
  184.     => Send: foo
  185.  
  186.     Command: end
  187.     => Okay
  188.  
  189.     Your message has been processed.
  190.     The following requests have been queued:
  191.  
  192.       request format (uncoded size) encoding limit remarks
  193.       ------- --------------------- -------- ----- -------
  194. [4]      INDEX   Plain (5K)            plain
  195.       bio     Compressed Tar (6K)   btoa       64K
  196.       zoo     Compressed Tar (171K) btoa       64K Parts 2,3,4 only
  197.       foo     Unknown                              Request skipped
  198.  
  199.     These requests will be sent to you as soon as the load of
  200.     the server system permits.
  201.  
  202.     Mail Server finished.
  203.  
  204. As you can see, the return mail is sent to the address [1] indicated
  205. by the PATH command [3]. If the PATH command were not issued, the
  206. address from the message header [2] would have been used.
  207. In the list of requests [4] the format and the size of the files are
  208. shown. Note that the size is the size *before encoding*!
  209. Finally, the request "foo" could not be found and is skipped.
  210.  
  211. Some time later the following mails will arrive:
  212.  
  213.     From                  Size      Subject
  214.     -------------------- --------- ----------------------------------
  215.     Wayne's Mail Server   73/4301  "INDEX (complete) ascii"
  216.     Wayne's Mail Server   96/7394  "bio.tar.Z (complete) btoa encoded"
  217.     Wayne's Mail Server  829/65453 "zoo.tar.Z (part 2 of 4) btoa encoded"
  218.     Wayne's Mail Server  829/65453 "zoo.tar.Z (part 3 of 4) btoa encoded"
  219.     Wayne's Mail Server  325/25578 "zoo.tar.Z (part 4 of 4) btoa encoded"
  220.  
  221. Files which are sent in parts have all pieces clearly marked as such:
  222.  
  223.     ------ begin of zoo.tar.Z -- btoa encoded -- part 2 of 4 ------
  224.     #(_0M#C)R-&3BEIu9#I[oEFn;50r5kb6%CJq%=NMgE3in`tMpnX0rOEYPWNM...
  225.     =69S\PiSodA"*lArTZ.-(g6DL2A6_5>DMuFV/&S7H/]XEgLe(l@e;-Rqr:iZ...
  226.     ...
  227.     ...
  228.     $`eP&iGea"a#e[F!oeo1r@U/FP;::i"V)j_EW+.(U*&IrTJ+u'9=$MY7s*CC...
  229.     uI=a5*Wj^#1LD,&>MZKY@H1_a9QE$$4[+?[ePhh"h2Ub"/a,(ES*ZH"nK"6d...
  230.     ------ end of zoo.tar.Z -- btoa encoded -- part 2 of 4 ------
  231.  
  232. Unpacking
  233. =========
  234. You may obtain the following packages from the server:
  235.  
  236.     btoa       btoa/atob support programs
  237.     uudecode       uuencode/uudecode support programs
  238.     PC.starter     A text file with how to get uudecode on your PC.
  239.     compression    A list of available compression program and where to find 
  240.            them.
  241.  
  242. These packages are send unencoded.
  243.  
  244. If you have Larry Wall's "perl" program, you can retrieve the program
  245. "unpack.pl" from the server. This will help you in unpacking the
  246. mails.
  247.  
  248. Send me mail if you have problems unpacking some files.
  249.  
  250. Submissions
  251. ===========
  252.  
  253. If you have any program you think I should have in my archive, just mail
  254. them to me.  (same address different subject)  I am always happy to
  255. expand my archive.
  256.  
  257.  
  258. By the way: the server software is also written in perl.
  259. The software is based on the Multihouse Research Mail Server 1.23
  260.  
  261. For questions, information and remarks:
  262.  
  263.     Wayne Scott
  264.  
  265. _______________________________________________________________________________
  266. Wayne Scott             |  INTERNET:   wscott@ecn.purdue.edu
  267. Electrical Engineering  |  BITNET:     wscott%ecn.purdue.edu@purccvm
  268. Purdue University       |  UUCP:      {purdue, pur-ee}!ecn.purdue.edu!wscott
  269. _______________________________________________________________________________
  270.                 "To iterate is human.  To recurse, divine."
  271.